<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>Configuration Processor Maven Plugin - config-processor:process</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
      </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Configuration Processor Maven Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2009-02-10
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Examples</h5>
            <ul>
              
    <li class="none">
                    <a href="examples/properties-processing.html">Properties Processing</a>
          </li>
              
    <li class="none">
                    <a href="examples/xml-processing.html">XML Processing</a>
          </li>
          </ul>
              <h5>Project Documentation</h5>
            <ul>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-info.html">Project Information</a>
                </li>
              
                
              
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
            
      
              
        <li class="collapsed">
                    <a href="project-reports.html">Project Reports</a>
                </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="config-processor:process"></a>
config-processor:process</h2>
<p><strong>Full name</strong>:</p>
<p>com.google.code.maven-config-processor-plugin:maven-config-processor-plugin:1.3-SNAPSHOT:process</p>
<p><strong>Description</strong>:</p>
<div>Generates modified configuration files according to configuration.
Includes, excludes and modify properties.</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven 2.0 project to be executed.</li>
<li>Binds by default to the lifecycle phase: <code>process-resources</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>
Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#outputDirectory">outputDirectory</a>
</strong></td>
<td><code>File</code></td>
<td><code>1.0</code></td>
<td>Output directory of the generated files.<br />
<strong>Default value is</strong>: <code>${project.build.directory}</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#transformations">transformations</a>
</strong></td>
<td><code>List</code></td>
<td><code>1.0</code></td>
<td>File transformations to be performed.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#useOutputDirectory">useOutputDirectory</a>
</strong></td>
<td><code>boolean</code></td>
<td><code>1.0</code></td>
<td>Indicate if should prefix file paths with the outputDirectory
configuration property.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>
Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#encoding">encoding</a>
</strong></td>
<td><code>String</code></td>
<td><code>1.1</code></td>
<td>Encoding to use when reading or writing files.<br />
<strong>Default value is</strong>: <code>${project.build.sourceEncoding}</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#indentSize">indentSize</a>
</strong></td>
<td><code>Integer</code></td>
<td><code>1.2</code></td>
<td>Indentation size as the number of whitespaces to use when
formatting.<br />
<strong>Default value is</strong>: <code>4</code>.</td>
</tr>
<tr class="b"><td><strong><a href="#lineWidth">lineWidth</a>
</strong></td>
<td><code>Integer</code></td>
<td><code>1.2</code></td>
<td>Maximum line width of the generated files to use when formatting.<br />
<strong>Default value is</strong>: <code>80</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#namespaceContexts">namespaceContexts</a>
</strong></td>
<td><code>Map</code></td>
<td><code>1.2</code></td>
<td>Namespace contexts for XPath expressions. Mapping in the form
prefix =&gt; url<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#specificProperties">specificProperties</a>
</strong></td>
<td><code>File</code></td>
<td><code>1.0</code></td>
<td>File to load aditional specific properties for plugin execution.<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>
Parameter Details</h3>
<p><strong><a name="encoding">encoding</a>
:</strong></p>
<div>Encoding to use when reading or writing files.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Since</strong>: <code>1.1</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li>
</ul>
<hr />
<p><strong><a name="indentSize">indentSize</a>
:</strong></p>
<div>Indentation size as the number of whitespaces to use when
formatting.</div><ul><li><strong>Type</strong>: <code>java.lang.Integer</code></li>
<li><strong>Since</strong>: <code>1.2</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>4</code></li>
</ul>
<hr />
<p><strong><a name="lineWidth">lineWidth</a>
:</strong></p>
<div>Maximum line width of the generated files to use when formatting.</div><ul><li><strong>Type</strong>: <code>java.lang.Integer</code></li>
<li><strong>Since</strong>: <code>1.2</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>80</code></li>
</ul>
<hr />
<p><strong><a name="namespaceContexts">namespaceContexts</a>
:</strong></p>
<div>Namespace contexts for XPath expressions. Mapping in the form
prefix =&gt; url</div><ul><li><strong>Type</strong>: <code>java.util.Map</code></li>
<li><strong>Since</strong>: <code>1.2</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="outputDirectory">outputDirectory</a>
:</strong></p>
<div>Output directory of the generated files.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>1.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>${project.build.directory}</code></li>
</ul>
<hr />
<p><strong><a name="specificProperties">specificProperties</a>
:</strong></p>
<div>File to load aditional specific properties for plugin execution.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Since</strong>: <code>1.0</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="transformations">transformations</a>
:</strong></p>
<div>File transformations to be performed.</div><ul><li><strong>Type</strong>: <code>java.util.List</code></li>
<li><strong>Since</strong>: <code>1.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
</ul>
<hr />
<p><strong><a name="useOutputDirectory">useOutputDirectory</a>
:</strong></p>
<div>Indicate if should prefix file paths with the outputDirectory
configuration property.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Since</strong>: <code>1.0</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2009
    
          None
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
